Package com.cisco.pt.ipc.system
Interface CommandLog
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
CommandLogImpl
Information provided by the PKI file:
\class CommandLog
\brief CommandLog serves as the entry point to all command log objects.
\example commandLog()
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Information provided by the PKI file:getEntryAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:booleanInformation provided by the PKI file:voidsetEnabled(boolean enabled) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
clear
void clear()Information provided by the PKI file:
\brief Clears the command log. -
setEnabled
void setEnabled(boolean enabled) Information provided by the PKI file:
\brief Enables or disables the command log. \param enabled, true to enable the command log, false to disable it.- Parameters:
enabled- Takes in a parameter of enabled
-
isEnabled
boolean isEnabled()Information provided by the PKI file:
\brief Returns true if the command log is enabled, otherwise false. \return bool, true if the command log is enabled, otherwise false.- Returns:
- boolean Returns a boolean
-
getEntryCount
int getEntryCount()Information provided by the PKI file:
\brief Returns the command log entry count. \return int, the command log entry count.- Returns:
- int Returns a int
-
getEntryAt
Information provided by the PKI file:
\brief Returns the CommandLogEntry object at the specified index. \param index, the index of the CommandLogEntry object of interest. \return CommandLogEntry, the CommandLogEntry object at the specified index.- Parameters:
index- Takes in a parameter of index- Returns:
- CommandLogEntry Returns a CommandLogEntry
-